-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(deps): update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.9.20 #172
base: master
Are you sure you want to change the base?
fix(deps): update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.9.20 #172
Conversation
390ac91
to
a8c4c2c
Compare
Kudos, SonarCloud Quality Gate passed! |
a8c4c2c
to
e763950
Compare
e763950
to
b760009
Compare
Kudos, SonarCloud Quality Gate passed! |
b760009
to
c963908
Compare
Kudos, SonarCloud Quality Gate passed! |
c963908
to
6665196
Compare
Kudos, SonarCloud Quality Gate passed! |
6665196
to
67be2c5
Compare
Kudos, SonarCloud Quality Gate passed! |
67be2c5
to
7f2ef7b
Compare
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
7f2ef7b
to
f45d55a
Compare
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
f45d55a
to
128192a
Compare
Quality Gate passedIssues Measures |
This PR contains the following updates:
1.6.20
->1.9.20
Release Notes
Kotlin/dokka (org.jetbrains.dokka:dokka-gradle-plugin)
v1.9.20
: 1.9.20General bugfixes
sealed
keyword in signatures (https://github.com/Kotlin/dokka/issues/2994)inner
keyword in Kotlin signatures (https://github.com/Kotlin/dokka/issues/2793)@param
tag not working with type parameters (https://github.com/Kotlin/dokka/issues/3199)HTML format
Runners
Gradle Plugin
Maven Plugin
dokka:help
being absent (https://github.com/Kotlin/dokka/issues/3035). Thanks to @aSemy!CLI runner
sourceRoots
configuration option (https://github.com/Kotlin/dokka/issues/2571)Plugin API
Other:
wasm-js
andwasm-wasi
targets introduced in Kotlin 1.9.20 are supported (https://github.com/Kotlin/dokka/issues/3310)See Dokka 1.9.20 milestone for the list of all changes.
v1.9.10
: 1.9.10General
HTML format
Gradle
Java
v1.9.0
: 1.9.0General improvements
HTML format
This release is packed with enhancements and bugfixes that make your API reference docs mobile-friendly!
You may find it a weird direction for improvement — we were just as surprised to find that almost 1/4 of Standard Library's API reference traffic is coming from mobile devices. Thanks to the Kotlin Website team, who contributed these improvements, Dokka now provides a solid experience to such visitors.
Improvements:
Bugfixes
Java interoperability
Javadoc format
@author
,@since
and@return
tags (https://github.com/Kotlin/dokka/issues/1770). Thanks to @irina-turova!Other
Known problems
Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see https://github.com/Kotlin/dokka/issues/3153 for more details and workarounds.
Breaking changes
This release introduces some breaking changes that are expected to affect only a fraction of Dokka users.
HTML
Note: this section only applies to those customizing Dokka's HTML format by overriding styles or HTML templates. If you are not doing any customizations, you may skip this section.
To lay a solid foundation to making the HTML format responsive, some page layouts and many styles had to be changed in a backward-incompatible manner.
If you are overriding
logo-styles.css
to provide your own header logo, please update it to be in line with the new styles - there is significantly less position hardcoding now. See this example for how it can be done.If you are overriding
styles.css
with your own file, please update the baseline styles to the latest, and see if anything is broken. If you get stuck with adapting your styles to the changes, the diff might help.If you are overriding
base.ftl
orheader.ftl
templates, please update them to the latest, and adapt your changes.CLI runner
Due to the analysis refactoring needed for the migration to K2 (#3099), the JARs required to run Dokka have slightly changed.
The following JARs are no longer supported or published:
Please, replace them with a single JAR:
Plugin API
An internal refactoring of Dokka's analysis API was much needed for the migration to K2, leading to breaking changes in some cases.
If your Dokka plugin compiles without any problems — you may ignore this information, you are likely not affected.
If something doesn't compile or doesn't work anymore, please see #3099 for more details.
v1.8.20
: 1.8.20Improvements
Bugfixes
TypeNotPresentException
thrown in projects without KGP (#2890), regression from 1.8.10.Gradle plugin
kotlin-dsl
plugin (#2702, #2833). Thanks to @aSemy!Plugin API
DokkaConsoleLogger
) toPROGRESS
(#2871)@InternalDokkaApi
annotation (#2904)Infrastructure
Big thanks to @aSemy, @Goooler and @3flex for their valuable contributions and for improving the internal
developer experience when working on Dokka!
buildSrc
to a composite build (#2912 by @Goooler)Documentation
README.md
(#2940). Thanks to @Goooler!CONTRIBUTING.md
(#2952)Security
Other
v1.8.10
: 1.8.10Dokka's documentation has been entirely rewritten and can now be found on kotlinlang.org:
Note: Version 1.8.0 was skipped due to a Metaspace memory leak in Kotlin's reflection (KT-56093). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0.
Improvements
Inheritors
,Parameters
,See also
andSamples
tabs into the main declaration description (#2688).Members
andMembers & Extensions
tabs to class-like declaration pages (#2764).Bugfixes
var
properties being displayed (#2717).DokkaLogger
(#2827).Gradle Plugin
NoSuchMethodError
when running under Gradle 8 (#2796).outputDirectory
input property (#556).moduleVersion
input property (#2799). Thanks to @JavierSegoviaCordoba!MultiModule
tasks (#2806). Thanks to @TWiStErRob!Javadoc
javadoc.jar
produced by Dokka is imported into IntelliJ IDEA / Android Studio (#2734). Thanks to @bomberaya!Plugin API
Infrastructure
Other
jackson-databind
to avoid CVE-2022-42003 (#2733). Thanks to @ryanlewis!Jsoup
to avoid CVE-2022-36033 (#2772).v1.7.20
: 1.7.20This release focuses primarily on improving user experience and HTML format in particular.
Improvements
General
suppressInheritedMembers
configuration property) (#2625)@Deprecated
declarations such as deprecation message, level and proposed replacement (#2622)Enum
's syntheticvalues()
andvalueOf()
functions (#2650)Java
constants (#2609)HTML format
Cmd + K
/Ctrl + K
hotkey for opening search dialog, thanks to @atyrin! (#2633)Javadoc format
var
HTML tag, thanks to @atyrin (#2617)Kotlin-as-Java plugin
Gradle runner
kotlin-stdlib
dependency, which should fix errors likeModule was compiled with an incompatible version of Kotlin
, thanks to @martinbonnin! (#2570)Bugfixes
Markdown
elements, where_try_ *this*
would be rendered astrythis
(#2640)StackOverflowError
related to type-aliased native references (#2664)IllegalStateException
that was caused by using JS's dynamic types (#2645)private
declarations were rendered aspublic
(#2639)@see
tag (#2627)Java
Enum types being rendered asAny
(#2647)Java
annotation params (#2593)sourceRoots
configuration param not handling single.java
files, thanks to @2017398956! (#2604)dokka-customFormat-example
project to use up-to-date logo styles (#2608)Developer experience
Gradle Enterprise
build scans, thanks to @Goooler! (#2641)GitHub Actions
artifacts to store generated documentation snapshots, thanks to @StefMa! (#2630)Other
v1.7.10
: 1.7.10Bugfix release that addresses several blockers and regressions.
General
Kotlin
1.7.10Gradle plugin
Kotlin
stdlib in plugin dependencies, this should fix errors likeModule was compiled with an incompatible version of Kotlin
when usingDokka
. Thanks to @martinbonnin (#2543)Java sources
Java
code (#2544)Java
sources (#2509, #2551, #2350)IntelliJ
platformWARN: Attempt to load key
messages that appeared when analyzingJava
sources (#2559)v1.7.0
: 1.7.0Improvements
General
Kotlin
1.7.0,IntelliJ
Platform 213Java
fields with accessors, now properly interpreted asval
/var
properties (https://github.com/Kotlin/dokka/pull/2481, https://github.com/Kotlin/dokka/pull/2532, https://github.com/Kotlin/dokka/pull/2540)@Deprecated
members withHIDDEN
level (https://github.com/Kotlin/dokka/pull/2486)HTML format
Javadoc format
Javadoc
pages generation deterministic (https://github.com/Kotlin/dokka/pull/2479)jQuery
to avoid multiple CVEs, thanks to @ToppleTheNun (https://github.com/Kotlin/dokka/issues/1938)GFM format
Kotlin-as-Java plugin
Java
access modifiers into function signatures, thanks to @tripolkaandrey (https://github.com/Kotlin/dokka/pull/2510)Gradle runner
dokka-analysis
dependencycompileOnly
, this should help avoid compatibility problems if different versions ofKotlin
are bundled inGradle
andDokka
(https://github.com/Kotlin/dokka/pull/2521)Gradle
tasks, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2500)Gradle
runner, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2502)Gradle
runner, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2501)Fixes
General bugfixes
Security
log4j
1.2 that came as a transitive dependency (https://github.com/Kotlin/dokka/issues/2488)Plugin API
base.ftl
template: nowheader.ftl
,footer.ftl
andpage_metadata.ftl
can be overridden individually (https://github.com/Kotlin/dokka/pull/2432)Other
Thanks to all the contributors!
v1.6.21
: 1.6.21This is a bugfix release that mostly enables building documentation for multiplatform projects that utilize
.klib
libraries.Changes
jsoup
dependency to avoid CVE-2021-37714 (#2448)Bugfixes
KLIB
libraries for common platform, previously led toERROR CLASS
instead of references in documentation (#2441)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.